home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat3 / Tm / tmtext.z / tmtext
Encoding:
Text File  |  1998-10-30  |  10.8 KB  |  331 lines

  1.  
  2.  
  3.  
  4. TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))                                                        TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      TTTTmmmmTTTTeeeexxxxtttt - the Text widget class
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      xxxxmmmmTTTTeeeexxxxtttt  pathName [options]
  13.  
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      This is the _t_c_l binding to the Motif Text widget.
  17.  
  18.  
  19. CCCCLLLLAAAASSSSSSSSEEEESSSS
  20.      The class name for resource files is XXXXmmmmTTTTeeeexxxxtttt.... Resources are inherited from
  21.      TTTTmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee,,,, TTTTmmmmCCCCoooorrrreeee.... Methods are inherited from TTTTmmmmCCCCoooorrrreeee....
  22.  
  23.  
  24. RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS
  25.      The new resources are
  26.  
  27.           autoShowCursorPosition
  28.           cursorPosition
  29.           editable
  30.           editMode br marginHeight
  31.           marginWidth
  32.           maxLength
  33.           source
  34.           topCharacter
  35.           value
  36.           valueWCS
  37.           verifyBell
  38.  
  39.      eeeeddddiiiittttaaaabbbblllleeee
  40.           The values for this resource are
  41.                true
  42.                false
  43.      eeeeddddiiiittttMMMMooooddddeeee The values for this resource are
  44.                single_line_edit
  45.                multi_line_edit
  46.  
  47.  
  48. MMMMEEEETTTTHHHHOOOODDDDSSSS
  49.      New methods for this class are
  50.           activateCallback
  51.           focusCallback
  52.           gainPrimaryCallback
  53.           losePrimaryCallback
  54.           losingFocusCallback
  55.           modifyVerifyCallback
  56.           motionVerifyCallback
  57.           valueChangedCallback
  58.           clearSelection
  59.           copy
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))                                                        TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))
  71.  
  72.  
  73.  
  74.           cut
  75.           disableRedisplay
  76.           enableRedisplay
  77.           findString
  78.           getEditable
  79.           getInsertionPosition
  80.           getSelection
  81.           getSelectionPosition
  82.           getString
  83.           getSubstring
  84.           getTopCharacter
  85.           insert
  86.           paste
  87.           replace
  88.           remove
  89.           scroll
  90.           setAddMode
  91.           setEditable
  92.           setHighlight
  93.           setInsertionPosition
  94.           setSelection
  95.           setSource
  96.           setString
  97.           setTopCharacter
  98.           showPosition
  99.  
  100.  
  101.      cccclllleeeeaaaarrrrSSSSeeeelllleeeeccccttttiiiioooonnnn
  102.           clears the primary selection
  103.  
  104.  
  105.      ccccooooppppyyyy copies the primary selection to the clipboard
  106.  
  107.  
  108.      ccccuuuutttt  copies the primary selection to the clipboard and deletes the
  109.           selected text.
  110.  
  111.  
  112.      ffffiiiinnnnddddSSSSttttrrrriiiinnnngggg  _s_t_a_r_t _s_t_r_i_n_g _d_i_r_e_c_t_i_o_n _p_o_s_i_t_i_o_n
  113.           searches for the _s_t_r_i_n_g in the specified _d_i_r_e_c_t_i_o_n starting from the
  114.           given _s_t_a_r_t. The possible values of _d_i_r_e_c_t_i_o_n are  ffffoooorrrrwwwwaaaarrrrdddd or
  115.           bbbbaaaacccckkkkwwwwaaaarrrrdddd.  The method returns  ttttrrrruuuueeee  or  ffffaaaallllsssseeee  if the string is
  116.           found or not found. If it is found, the location of the first
  117.           character of the string (counting from 0) is returned in the tcl
  118.           variable _p_o_s_i_t_i_o_n.
  119.  
  120.  
  121.      ggggeeeettttEEEEddddiiiittttaaaabbbblllleeee
  122.           returns  ttttrrrruuuueeee or  ffffaaaallllsssseeee indicating whether or not the widget can be
  123.           edited.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))                                                        TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))
  137.  
  138.  
  139.  
  140.      ggggeeeettttIIIInnnnsssseeeerrrrttttiiiioooonnnnPPPPoooossssiiiittttiiiioooonnnn
  141.           returns the location of the insertion cursor.
  142.  
  143.  
  144.      ggggeeeettttLLLLaaaassssttttPPPPoooossssiiiittttiiiioooonnnn
  145.           returns the last position in the text.
  146.  
  147.  
  148.      ggggeeeettttSSSSeeeelllleeeeccccttttiiiioooonnnn
  149.           returns the value of the primary selection.
  150.  
  151.  
  152.      ggggeeeettttSSSSeeeelllleeeeccccttttiiiioooonnnnPPPPoooossssiiiittttiiiioooonnnn  _l_e_f_t _r_i_g_h_t
  153.           returns  ttttrrrruuuueeee f the widget owns the primary selection, else returns
  154.           ffffaaaallllsssseeee.  The left and right positions of the primary selection are
  155.           returned in the tcl variables
  156.            _l_e_f_t  and  _r_i_g_h_t.
  157.  
  158.  
  159.      ggggeeeettttSSSSttttrrrriiiinnnngggg
  160.           returns the value in the widget.
  161.  
  162.  
  163.      ggggeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg  _s_t_a_r_t _n_u_m__c_h_a_r_s _b_u_f_f_e_r
  164.           stores the substring in the tcl variable _b_u_f_f_e_r. The method returns
  165.           ssssuuuucccccccceeeeddddeeeedddd,  ffffaaaaiiiilllleeeedddd or  ttttrrrruuuunnnnccccaaaatttteeeedddd.
  166.  
  167.  
  168.      ggggeeeettttTTTTooooppppCCCChhhhaaaarrrraaaacccctttteeeerrrr
  169.           returns the position of the first character displayed.
  170.  
  171.  
  172.      iiiinnnnsssseeeerrrrtttt  _p_o_s_i_t_i_o_n _t_e_x_t
  173.           inserts the  _t_e_x_t into the widget at  _p_o_s_i_t_i_o_n.
  174.  
  175.  
  176.      ppppaaaasssstttteeee
  177.           insert the clipboard selection.
  178.  
  179.  
  180.      rrrreeeeppppllllaaaacccceeee  _f_r_o_m _t_o _v_a_l_u_e
  181.           replaces the text with the new  _v_a_l_u_e.
  182.  
  183.  
  184.      ssssccccrrrroooollllllll  _l_i_n_e_s
  185.           scroll the text widget. A negative number of lines scrolls downward.
  186.  
  187.  
  188.      sssseeeettttAAAAddddddddMMMMooooddddeeee  _b_o_o_l_e_a_n
  189.           sets the add mode of the text widget.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))                                                        TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))
  203.  
  204.  
  205.  
  206.      sssseeeettttEEEEddddiiiittttaaaabbbblllleeee  _b_o_o_l_e_a_n
  207.           set the editable state of the widget.
  208.  
  209.  
  210.      sssseeeettttHHHHiiiigggghhhhlllliiiigggghhhhtttt   _l_e_f_t _r_i_g_h_t _m_o_d_e
  211.           set the highlight mode for the text between the positions to one of
  212.           the  _h_i_g_h_l_i_g_h_t values of nnnnoooorrrrmmmmaaaallll sssseeeelllleeeecccctttteeeedddd sssseeeeccccoooonnnnddddaaaarrrryyyy____sssseeeelllleeeecccctttteeeedddd.
  213.  
  214.  
  215.      sssseeeettttIIIInnnnsssseeeerrrrttttiiiioooonnnnPPPPoooossssiiiittttiiiioooonnnn  _p_o_s_i_t_i_o_n
  216.           set the location of the insertion cursor.
  217.  
  218.  
  219.      sssseeeettttSSSSeeeelllleeeeccccttttiiiioooonnnn  _f_i_r_s_t _l_a_s_t
  220.           set the primary selection of the text to between the positions.
  221.  
  222.  
  223.      sssseeeettttSSSSoooouuuurrrrcccceeee  _w_i_d_g_e_t _t_o_p _p_o_s_i_t_i_o_n
  224.           sets the source of the current text widget to be the same as
  225.            _w_i_d_g_e_t and specifies where the top display and where the insertion
  226.           cursor are.
  227.  
  228.  
  229.      sssseeeettttSSSSttttrrrriiiinnnngggg  _v_a_l_u_e
  230.           sets the text value.
  231.  
  232.  
  233.      sssseeeettttTTTTooooppppCCCChhhhaaaarrrraaaacccctttteeeerrrr  _t_o_p
  234.           sets the top position of the text display.
  235.  
  236.  
  237.      sssshhhhoooowwwwPPPPoooossssiiiittttiiiioooonnnn  _p_o_s_i_t_i_o_n
  238.           force the text at the  _p_o_s_i_t_i_o_n to be displayed.
  239.  
  240.  
  241. CCCCAAAALLLLLLLLBBBBAAAACCCCKKKK SSSSUUUUBBBBSSSSTTTTIIIITTTTUUUUTTTTIIIIOOOONNNNSSSS
  242.      The substitutions supported for this class are
  243.           %%%%rrrreeeeaaaassssoooonnnn  - the additional values are
  244.                activate
  245.                focus
  246.                gain_primary
  247.                lose_primary
  248.                modifying_text_value
  249.                moving_insert_cursor
  250.                value_changed
  251.           %%%%ddddooooiiiitttt - the tcl variable to set to true or false to allow changes
  252.           %%%%ccccuuuurrrrrrrrIIIInnnnsssseeeerrrrtttt - current position of the insertion cursor
  253.           %%%%nnnneeeewwwwIIIInnnnsssseeeerrrrtttt - position to which cursor move is attempted
  254.           %%%%ssssttttaaaarrrrttttPPPPoooossss - itcl variable with starting position of text to modify
  255.           %%%%eeeennnnddddPPPPoooossss - tcl variable with end position of text to modify
  256.           %%%%ppppttttrrrr - tcl variable with text to be inserted
  257.           %%%%lllleeeennnnggggtttthhhh - tcl variable with length of text to be inserted
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))                                                        TTTTmmmmTTTTeeeexxxxtttt((((3333TTTTmmmm))))
  269.  
  270.  
  271.  
  272. AAAAUUUUTTTTHHHHOOOORRRR
  273.      Jan Newmarch, University of Canberra
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.